Skip to main content
Version: 11.5.1

Promaton HTTP API

This API supports the upload of dental imaging data — such as STL and 3D DICOM files — and retrieval of outputs from machine-learning products, such as optical scan / CBCT segmentation, alignment / fusion of meshes and automated crown design.

Tasks​

Because inferences take longer than some proxy servers allow open connection for, we accept all uploads as a task which you can monitor until it reaches completion.

Monitoring can be done via polling.

Authentication​

Authentication is done by setting your api key in the Authorization header, prefixed with Bearer, like so: Bearer <yourtoken>.

Depending on your API token, you can have access to either OSS, CBCT, ACD or all.

Uploading your first STL​

You can upload your first STL using the following curl command:

curl -X POST "https://api.promaton.com/oss/lower" \
    -H "Authorization: Bearer <your token>"" \
    -H "Accept: application/json" \
    -H "Content-Type: model/stl" \
    --data-binary "@path/to/scan.lower.stl"

After that, you can get the status of your task using the id of the task returned to you, in the following curl command:

curl "https://api.promaton.com/oss/{your task id}" \
    -H "Authorization: Bearer <your token>""
    -H "Accept: application/json"

Until it reaches the completed state.

After completion, polling the task will return the results. You can then use the download endpoints given in the results to download individual structures.

If an error occurs during processing, the task state will switch to errored.

Response times​

We shut down our servers whenever possible to reduce cost. You therefore may experience a "cold start" when first calling our API. This takes at most five minutes. After that, the response times should be on par.

Task pagination​

All tasks offer a pagination endpoint. Because tasks can be added while you are paginating, we work with a pointer-based approach using a task id.

If you want to start paginating from the most recent task to older tasks, you can call (for example) /cbct?sort_order=desc&limit=10. Then, for the next 10 items, you take the id last item of the previous result, and send that along as the from_id like this: /cbct?sort_order=desc&limit=15&from_id=ckbulxexk0016xapiz8h3g2pn.

Changelog​

The changelog has moved and is available here

Patents​

The following products are protected by patents in the U.S. and elsewhere, all or some of which are third party intellectual property rights. This website is provided to satisfy the virtual patent marking provisions of various jurisdictions including the virtual patent marking provisions of the America Invents Act. The following list of products may not be all inclusive, and other products not listed here may be protected by one or more patents.

US Patent Number 11,379,975, US Patent Number 11,568,533 - for Segmentation of 3D anatomical structures

US Patent Number 11,455,774 - for Root Shape Prediction

US Patent Number 12,229,993 - Alignment of 3D tooth surfaces using deep learning

Authentication​

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer